home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 25 / Cream of the Crop 25.iso / windows / comnt11.zip / PACK1.PRG / VB / 0 / SW / FILES / MANUAL.TXT < prev    next >
Text File  |  1997-03-29  |  13KB  |  278 lines
  1.  
  2.  
  3.  
  4.  
  5.          OVERVIEW
  6.  
  7.          Easy Software's Commentator allows you to associate text
  8.          comments with any file and to search for text in your comments.
  9.          When Commentator finds the text you have searched for it also
  10.          finds the associated file. You can then launch any application
  11.          with that file name on the command line.  Commentator is
  12.          suitable for any application which accepts a workfile on the
  13.          command line such as Word Processors, CAD, Desktop Publishers,
  14.          Midi Editors Etc.
  15.  
  16.          SETTING UP YOUR APPLICATIONS
  17.  
  18.          When you first start Commentator, click the "Setup Applications"
  19.          button. The setup window has the following fields:-
  20.  
  21.          Application Name
  22.  
  23.          This is the name that will be shown on the application launch
  24.          button. Eg. Autocad, MS Publisher, Cubasis Etc.
  25.  
  26.          Application Executable
  27.  
  28.          This is the full path and filename of the application to launch.
  29.          There is a browse button.
  30.  
  31.          File Filter
  32.  
  33.          This is the filter to use with the application. For example:-
  34.          *.MID for Midi applications, *.PUB for Desktop publishing. You
  35.          can have multiple filters by separating them with a semi-colon.
  36.          For Example, a word processor might have the filter:-
  37.          *.txt;*.bat;*.ini. If you leave this blank the default is *.*.
  38.  
  39.          Working Directory
  40.  
  41.          This is the directory which Commentator will make current when
  42.          it launches your application. This defaults to the application's
  43.          directory. You can select "Work File Directory" in which case
  44.          Commentator will make the directory of the work file you choose
  45.          current. If you want another directory to be current, choose
  46.          "Custom" and type in the directory name.  (Some applications 
  47.          will only load correctly with the first option)
  48.  
  49.          DOS Applications
  50.  
  51.          If your application is DOS you can choose to have Commentator
  52.          call direct to the application name or to create a PIF file
  53.          either for full screen or a DOS box. The PIF files which
  54.          Commentator creates have default values for everything except
  55.          the full screen/DOS box options. If your application requires a
  56.          PIF with non default values then set the DOS option to "Call
  57.          Direct" and use your PIF name in the Application Executable
  58.          field.
  59.  
  60.  
  61.          Additional Parameter
  62.  
  63.          If you need to call your application with command line switches
  64.          other than the filename to edit, you can enter them here and
  65.          Commentator will append them to the command line after the
  66.          chosen work file.
  67.  
  68.          First Directory to Search
  69.  
  70.          This is the directory in which Commentator will start when this
  71.          application is selected. Set it to the directory which contains
  72.          your current work files for the application. There is a browse
  73.          button to select with. (Default is the root of the Windows drive)
  74.  
  75.          Launch App Maximized
  76.  
  77.          By default, Commentator will launch your application in a normal
  78.          window. Check this option to launch maximized. ( Some
  79.          applications override this option)
  80.  
  81.          Minimize on Use
  82.  
  83.          Most editing applications use the full screen so you can
  84.          normally leave this unchecked and Commentator will be ready for
  85.          use when you close the application. If the application is not
  86.          full screen you can check this and Commentator will minimize
  87.          after launching the application.
  88.  
  89.          Unload on Use
  90.  
  91.          If the application requires all available memory, check this
  92.          option and Commentator will unload after launching it. (This
  93.          option may not work with some 32 bit applications)
  94.  
  95.          Save Modify Exit
  96.  
  97.          When you have filled all the fields, click the Save button. You
  98.          can set up more applications now or you can click the Exit
  99.          button to return to the main screen. To edit the settings for an
  100.          application, click the Modify button, select the application and
  101.          edit the fields. You can delete an application by clicking the
  102.          Delete button which appears to the right of the application name
  103.          after selecting "Modify".
  104.  
  105.          Password         
  106.  
  107.          If you administer several PCs you may not wish users to alter
  108.          your setup. You can password protect the setup and purge buttons
  109.          by clicking the password button.         
  110.  
  111.          When you return to the main window, you will notice that the
  112.          launch button has turned red and contains the name of the last
  113.          application you setup and that the directory/file boxes are set
  114.          to the directory you chose as the first directory to search.
  115.          If you have setup more than one application you can switch
  116.          between them by clicking the Change Application Button. If you
  117.          don't like the red color for the launch button, you can choose
  118.          from a range of colors by right clicking on the button.
  119.  
  120.   
  121.  
  122.          COMMENTING YOUR FILES
  123.  
  124.          There are two comment entry fields. One for directory comments
  125.          and one for file comments. They accepts a maximum of 176
  126.          characters. Type in the comment you wish to associate with the
  127.          highlighted file or directory and click the Save Comment button
  128.          or press F2 ( All main buttons have function key alternatives
  129.          if you prefer not to reach for the mouse) Your comment will now
  130.          appear in the comment box whenever this file is highlighted.
  131.          You can edit your comments at any time and re-save them with F2.
  132.          You can paste text from the clipboard into comment fields by
  133.          pressing Shift+Ins and you can cut or copy text from the comment
  134.          fields by selecting the text and right clicking for the Edit Menu.
  135.  
  136.          SEARCHING YOUR COMMENTS
  137.  
  138.          To search your comments, enter search text in the search field
  139.          immediately below the Comment boxes and press return, F4 or click
  140.          the Search button. If no match is found, Commentator will beep.
  141.          If a match is found but it is not associated with the file you
  142.          want, press return again without changing the search text and
  143.          Commentator will find the next match.
  144.  
  145.          When you have found the file you want, click the red launch
  146.          button to start the application with the selected file.
  147.  
  148.          There are options to search the highlighted directory or all
  149.          directories. The All directories option is sensible if you have
  150.          a limited number of commented files which are scattered
  151.          throughout several directories. However, indexing the comments
  152.          for a directory can take time. (Indexing a directory with 1000
  153.          comments on a pentium 120 takes 4-5 seconds) If you know which
  154.          directory the file you are looking for is in you can speed the
  155.          search by pre-selecting that directory and using the "This
  156.          Directory" search option. If you have many commented directories
  157.          You can search the directory comments by clicking the Directories
  158.          only button.
  159.  
  160.  
  161.          COMMENT STORAGE
  162.  
  163.          The comments you save are not attached in any way to the files
  164.          to which they relate. They are stored in files named COMMENT.DAT
  165.          There is one COMMENT.DAT file in each directory which contains
  166.          commented files. You should backup these files along with the
  167.          files to which they relate. If you erase COMMENT.DAT you have
  168.          lost your comments !  The Multi User version also creates two
  169.          small files, COMMENT.LOC and COMMENT.UPD in each commented
  170.          directory. These files are only required while workstations
  171.          are using Commentator.
  172.  
  173.          A list of the directories with COMMENT.DAT files is stored in
  174.          COMMENT.DRS in the Commentator directory. COMMENT.DRS is plain
  175.          ASCII so you can view it with any text editor. COMMENT.DRS is
  176.          used when you search with the "All Directories" option so do not
  177.          delete it.
  178.  
  179.          When you delete files for which you have saved comments, the
  180.          comments themselves are not deleted. Commentator will remove
  181.          comments for files which no longer exist when you click the
  182.          Purge Deleted Comments button.  If you have a large number of
  183.          comments, purging can take a considerable time. There is no need
  184.          to diligently purge whenever you delete a file but as the number
  185.          of redundant comments grows, so the indexing and search routines
  186.          will slow down.  Occasional purging will rectify this as well as
  187.          free up disk space.
  188.  
  189.          LIMITATIONS
  190.  
  191.          There is no limitation on the total number of comments. The
  192.          number of comments which can be indexed for one directory is
  193.          limited by memory. Commentator has been tested to 1000 commented
  194.          files per directory under Windows 3.1 and 95.
  195.  
  196.          NETWORK INSTALLATIONS
  197.  
  198.          The recommended configuration for network use is a separate
  199.          copy of Commentator Multi User on the local drive of each
  200.          work station which will be using it.  This produces the minimum
  201.          network traffic and allows each work station to have it's own
  202.          application setup file.  You can install a single copy of 
  203.          Commentator on the server for use by all work stations but this
  204.          is not recommended. If you do this, all workstations will share
  205.          the same setup and default screen colors. If the server is also
  206.          used as a work station, there is a further complication in the
  207.          fact that any application on the server will have to be set up
  208.          twice as the server will reference it by its local drive letter
  209.          and all other workstations will reference it by the network drive
  210.          letter.
  211.           
  212.          If you purchase the Multi User version of Commentator, Your
  213.          license allows you to install copies on any number of work
  214.          stations on a single LAN. You only need multiple licenses to
  215.          use it on multiple local area networks.
  216.  
  217.          If you purchase the single user version of Commentator, your
  218.          licence is for a single CPU.  There are no locking facilities
  219.          in the single user. If you run two copies of the single user
  220.          on a local area network, you will get all sorts of problems.
  221.  
  222.          The evaluation (Shareware) version is Multi User.
  223.  
  224.  
  225.          PROBLEMS
  226.  
  227.          Searching all directories no longer finds comments in a directory.
  228.  
  229.          If, when searching all directories, Commentator cannot find one
  230.          of the directories in COMMENT.DRS, it assumes that the directory
  231.          has been erased and removes its entry from COMMENT.DRS. If the
  232.          reason for not finding that directory was that it was on a 
  233.          removable drive or was on a network drive which was temporarily
  234.          disconnected you will get this problem the next time the drive
  235.          is connected. To rectify it, just log to that directory and
  236.          re-save any one of your comments.
  237.  
  238.  
  239.  
  240.          EVALUATION LICENSE
  241.  
  242.          If this is an evaluation copy, you are licensed to use it for
  243.          thirty days only. If you wish to continue using Commentator
  244.          beyond the evaluation period, you must purchase a registered
  245.          copy.  If you continue to use the evaluation copy beyond the
  246.          evaluation period, it will remind you of this obligation. At
  247.          no time, however, will it cease to function or erase any of
  248.          your comment data. 
  249.  
  250.          Full copies of Commentator cost:- $40 Single User
  251.                                            $150 Multi User
  252.  
  253.          Site Licenses are also available.
  254.  
  255.          A site licence consists of a single copy of the software
  256.          together with a licence to duplicate and use that software on
  257.          multiple machines. Copies made under a site licenses are for 
  258.          in-house use by the licensee and may not be resold. To calculate
  259.          a site licence price, multiply the price for a single copy by the
  260.          number of copies required and apply the following discounts:
  261.  
  262.          2          40%
  263.          3-7        60%
  264.          10-16      70%
  265.          25-56      80%
  266.          75-133     85%
  267.          200-500    90%
  268.          1000+      95%
  269.  
  270.  
  271.  
  272.          Note:
  273.  
  274.          If you install a copy of Commentator on a workstation with
  275.          access to directories on a network drive which have already
  276.          been commented, the all directories search will not work
  277.          until you have saved a comment in each directory from the 
  278.          workstation.